/*
 * Copyright 2011 Mark Davidson.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package org.dctmcommons;

import com.documentum.fc.client.IDfSession;
import com.documentum.fc.common.DfException;

/**
 * Virtual document related helper methods.
 * @author Mark Davidson
 */
public interface IVirtualDocHelper {

	/**
	 * Identifies the object ids of a virtual document's child documents.
	 * @param session The session
	 * @param objectId The object id of the virtual document
	 * @param includeRoot Whether to include the root node in the results
	 * @param recursive Whether to recurse through descendants
	 * @return The list of object ids
	 * @throws DfException The repository exception
	 */
	public String[] getChildDocumentIds(final IDfSession session,
										final String objectId,
										final boolean includeRoot,
										final boolean recursive)
		throws DfException;
	
}
